home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / memory & system tools / vmm / doc / vmm_rexx.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  6KB  |  143 lines
  1. @database doc/VMM_Rexx.guide
  2. @Width 72
  3. @Node Main "doc/VMM_Rexx.guide"
  4. This  document  describes  VMM's  ARexx  functions.   VMM  supports 18
  5. functions  for use in ARexx scripts.  Each function is listed with its
  6. parameters and the results it can produce.
  7. Supported commands:
  8.   @{"ADD_PROG   "   Link "Add_Prog"}
  9.   @{"DISABLE    "   Link "Disable"}
  10.   @{"ENABLE     "   Link "Enable"}
  11.   @{"HELP       "   Link "Help"}
  12.   @{"HIDE       "   Link "Hide"}
  13.   @{"INFO       "   Link "Info"}
  14.   @{"MEM        "   Link "Mem"}
  15.   @{"MEMTRACK   "   Link "MemTrack"}
  16.   @{"MEMTYPE    "   Link "MemType"}
  17.   @{"MINVMALLOC "   Link "MinVMAlloc"}
  18.   @{"PATCHWB    "   Link "PatchWB"}
  19.   @{"REM_PROG   "   Link "Rem_Prog"}
  20.   @{"SHOW       "   Link "Show"}
  21.   @{"STAT       "   Link "Stat"}
  22.   @{"VMPRIORITY "   Link "VMPriority"}
  23.   @{"WRITEBUFFER"   Link "WriteBuffer"}
  24.   @{"QUIT       "   Link "Quit"}
  25.   @{"ZOOM       "   Link "Zoom"}
  26. The  return codes used by those commands are the same as those used by
  27. the standard MUI ARexx-Interface.  These are:
  28.   -2     Not enough memory to carry out command
  29.   -3     Unknown ARexx command
  30.   -4     Syntax error in command's parameters
  31. @EndNode
  32. @Node Add_Prog "doc/VMM_Rexx.guide"
  33. Command: ADD_PROG "task name" <MinPublic> <MinNonPublic> "ON" | "OFF"
  34. The ADD_PROG command adds a task to VMM's task list with the specified
  35. settings.  The MinPublic and MinNonPublic parameters correspond to the
  36. advanced  options  section  in VMM's GUI.
  37. If  you like to specify "Use VM", set MinPublic to -1 and MinNonPublic
  38. to  0;  if you like to specify "Don't use VM", set MinPublic to -1 and
  39. MinNonPublic to -1.
  40. ON  or  OFF  determines the type of code paging used for the specified
  41. program.
  42. @EndNode
  43. @Node Disable "doc/VMM_Rexx.guide"
  44. Command: DISABLE
  45. The  command disables allocation of virtual memory until it is enabled
  46. again  using  either  the  corresponding  ARexx  command or the enable
  47. hotkey.
  48. @EndNode
  49. @Node Enable "doc/VMM_Rexx.guide"
  50. Command: ENABLE
  51. The  command enables allocation of virtual memory until it is disabled
  52. by invoking the hotkey or specifying the Arexx command DISABLE.
  53. @EndNode
  54. @Node Help "doc/VMM_Rexx.guide"
  55. Command: HELP "file"
  56. This  command  prints  a  list  of  all  available  ARexx  commands to
  57. "filename".   The  filename  specified  should  contain  a  full path,
  58. otherwise the file may be written into a directory you don't expect.
  59. @EndNode
  60. @Node Hide "doc/VMM_Rexx.guide"
  61. Command: HIDE
  62. This command causes VMM to hide its user interface.
  63. @EndNode
  64. @Node Info "doc/VMM_Rexx.guide"
  65. Command: INFO "title" | "author" | "copyright" | "description" | 
  66.               "version" | "base" | "screen"
  67. This  is  a standard MUI Arexx command.  Depending on the argument the
  68. result string will be filled with the following information:
  69.            "title"            Name of the program (VMM)
  70.            "author"           Author of the program
  71.            "copyright"        Copyright status
  72.            "description"      A short description of the program
  73.            "version"          version string
  74.            "base"             Name of the ARexx-port
  75.            "screen"           Name of the public-screen used (NULL)
  76. @EndNode
  77. @Node Mem "doc/VMM_Rexx.guide"
  78. Command: MEM ("FIXED" <size>) | "DYNAMIC" | ("RESTRICTED" <min> <max>)
  79. This  command  changes  the  way  and/or the amount of physical memory
  80. dedicated to virtual memory.
  81. size,  min  and  max  are  specified  in  bytes.  These values will be
  82. rounded to multiples of the current pagesize automatically.  If either
  83. of these values is too small it will be adjusted.
  84. @EndNode
  85. @Node MemTrack "doc/VMM_Rexx.guide"
  86. Command: MEMTRACK "ON" | "OFF"
  87. This command enables or disables memory tracking.
  88. @EndNode
  89. @Node MemType "doc/VMM_Rexx.guide"
  90. Command: MEMTYPE "FAST" | "CHIP" | "ANY"
  91. This  command specifies the type of memory used for paging.  This only
  92. influences page frames allocated after this command has executed.
  93. @EndNode
  94. @Node MinVMAlloc "doc/VMM_Rexx.guide"
  95. Command: MINVMALLOC <num_bytes>
  96. This  command  specifies  the  minimum request size to go into virtual
  97. memory.   Requests  smaller  than  this  value will be put into public
  98. memory.
  99. @EndNode
  100. @Node PatchWB "doc/VMM_Rexx.guide"
  101. Command: PATCHWB "ON" | "OFF"
  102. This  command  specifies  whether  to  patch  Workbench to display the
  103. amount of free virtual memory in its titlebar.
  104. @EndNode
  105. @Node Rem_Prog "doc/VMM_Rexx.guide"
  106. Command: REM_PROG "taskname"
  107. This command removes the specified task from VMM's task list.  If this
  108. program isn't found in the list nothing will be done.
  109. @EndNode
  110. @Node Show "doc/VMM_Rexx.guide"
  111. Command: SHOW
  112. This command causes VMM to display its user interface.
  113. @EndNode
  114. @Node Stat "doc/VMM_Rexx.guide"
  115. Command: STAT "ON" | "OFF"
  116. This command causes the statistics window to be turned on or off.
  117. @EndNode
  118. @Node VMPriority "doc/VMM_Rexx.guide"
  119. Command: VMPRIORITY <prio>
  120. This  command  causes  the  priority of virtual memory to be adjusted.
  121. This  can  influence  whether  virtual  or  physical memory is used up
  122. first.
  123. @EndNode
  124. @Node WriteBuffer "doc/VMM_Rexx.guide"
  125. Command: WRITEBUFFER <size>
  126. This  command specifies the size of the write buffer used to write out
  127. pages to disk.  It will be automatically rounded down to a multiple of
  128. the current page size.
  129. @EndNode
  130. @Node Quit "doc/VMM_Rexx.guide"
  131. Command: QUIT
  132. This  causes  VMM  to  quit if possible.  If there is too much virtual
  133. memory  allocated,  so  it  does not fit into physical memory, VMM may
  134. refuse to quit.
  135. @EndNode
  136. @Node Zoom "doc/VMM_Rexx.guide"
  137. Command: ZOOM "ON" | "OFF"
  138. This  command  causes  the zoomed state of the statistics window to be
  139. changed.   If  the statistics window is not currently opened the state
  140. will  be saved for later usage.  Thus opening the statistics window in
  141. zoomed state should first use ZOOM ON and then STAT ON.
  142. @EndNode
  143.